|
|
APIServer.AuthorizedEvents.CreateAuthorizedEvent
| Field | Variable | ...as | Description |
|---|---|---|---|
| AuthorizedEventImplName | Input | Input | The name of the authorized event. This is the implementation
name of the EventHandler that is used to implement the event.
Mandatory. |
| AuthorizedEventDescription | Input | Input | A text description of the authorized event - as the name is an implementation name, this field can be |
| AuthorizedEventActive | Input | Input | Active - The authorization of the event is evaluated.
Inactive - The authorization is not evaluated (so in fact this is just like a normal event). This allows you to deactivate the authorization check for a specific event without having to delete the registrations for the event. |
| AuthorizedEventSiteKey | Input | Input | The unique identification of the site the event belongs to. |
| Comment | Input | Input | A comment for the authorized event. |
| AuthorizedEventSurrogate | Key | Output | The unique identification of the created event. |
| NumberOfErrors | Error | Output | The number of errors returned in the error array. |
| ErrorMessage | ErrorArray
...occurs 10 |
Output | Messages stating why the creation was unsuccessful. |
The API creates a new authorized event.
You can use this if you create a deployment program where you want to auto create the authorized events in the site you want to deploy in. Use this API together with the AuthorizedEvents.AddRole API to create the full definitions for the event.
Online documentation - WebsydianExpress v3.5